home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / BARNET / FREENET / BRODIE / GOPHERD_ / ReadMe1st
Text File  |  1997-04-23  |  4KB  |  130 lines
  1. !GopherD
  2. ========
  3.  
  4. Contents:
  5.     Legal Declaration
  6.     How to structure a gopher database
  7.     How to write a gopher menu
  8.     How to edit the top level menu
  9.     How to browser your gopher database with ArcWeb
  10.     
  11.  
  12. Legal Declaration
  13. =================
  14.  
  15. In the legal declaration below, "This Product" is defined to be all the
  16. files within the original archive.
  17.  
  18. "the author" is Stewart Brodie (S.N.Brodie@ecs.soton.ac.uk)
  19.  
  20. Copyright of the product remains with the author.
  21.  
  22. This version of this product is 'freeware'.  My definition of 'freeware': 
  23. This means that the author retains copyright over the product, but allows
  24. unlimited distribution except:
  25.  
  26.  
  27.    i) No charge must be made (except for a nominal fee for distribution media)
  28.   ii) This Product must be distributed as a complete package
  29.  iii) This Product may not be distributed as part of a non-free
  30.       [free as in (i)] package (of any kind, magazine/hardware/software)
  31.       without prior written consent from the author
  32.       authors.
  33.   iv) If any further distribution occurs compliant with all of the above,
  34.       credit must be clearly given to the author
  35.  
  36. No liability whatsoever is accepted by the author of this product for losses
  37. or damage of any kind at all arising, or allegedly arising, from the use, or
  38. misuse, of This Product.  You are hereby warned that any costs incurred
  39. through the use of this package over a non-free networking medium are the
  40. sole responsibility of the user.
  41.  
  42. The author does not guarantee the functionality of the package, and does not
  43. guarantee to fix any reported bugs, although the author will investigate bug
  44. reports and may release new versions.
  45.  
  46.  
  47. How to structure a gopher database
  48. ==================================
  49.  
  50. Gopher objects have a (single ASCII character) type associated with them.  It
  51. is conventional to create a subdirectory for each type and place the objects
  52. inthese subdirectories, sorted by type, although it is not a requirement of
  53. the gopher protocol.
  54.  
  55. Gopher databases usually have hierarchies of menus 
  56.  
  57.  
  58. How to write a gopher menu
  59. ==========================
  60.  
  61. Gopher menus have each entry on its own line.  You will need a text editor
  62. which preserves TAB characters!   The format of a menu line is:
  63.  
  64. typeDescriptionTABselectorTABhostnameTABport
  65.  
  66. where:
  67.   * type is the single ASCII type character (see below)
  68.   * Description is the user-visible name of the object
  69.   * selector is the opaque selector to retrieve the object
  70.   * hostname is the gopher host where this object is
  71.   * port is the TCP port number on which the gopher server resides on hostname
  72.   * TAB is a single byte ASCII 9 character.
  73.  
  74. Main type bytes are: (see RFC1436 for a list) [Note: there are duplicates
  75. in the list - you should use the alphabetic character version in preference
  76. to any punctuation character]
  77.  
  78. 0  text document [Note: this is ASCII character 48, not ASCII NUL]
  79. 1  gopher menu
  80. 7  searchable index (not implemented in current version of !gopherd)
  81. 8  telnet
  82. 9  binary file
  83. g  GIF
  84. H  HTML
  85. h  HTML 
  86. I  image
  87. ;  movie
  88. <  sound
  89. s  sound
  90.  
  91. End the menu by having a single . character on a line on its own.
  92.  
  93. Note that the 'selector' is completely opaque to any client (ie. it
  94. mustn't parse it).  It will be sent as is to the server, or a web
  95. client will convert it into a hyperlink reference as:
  96. gopher://host:port/selector
  97.  
  98. There is no concept of relative filenames.
  99.  
  100.     
  101. How to edit the top level menu
  102. ==============================
  103.  
  104. Edit the menu in !GopherD.gopher_top
  105.  
  106.  
  107. How to browse your gopher database with ArcWeb
  108. ==============================================
  109.  
  110. You can browse your new gopher database with any web browser which 
  111. supports gopher either natively (like ArcWeb 0.37 and later) or
  112. via a proxy.  The URL for the top level menu of the server is
  113. just:  gopher://host.domain/   where host.domain is your machine
  114. name.  In reality, the URL should be gopher://host.domain/1 indicating
  115. that it is a menu, but web browsers assume this.  The 1  ^^^ is the
  116. gopher type byte.  It is used by the web browser to predetermine the
  117. type of object which it is downloading and is NOT passed to the gopher
  118. server at all.
  119.  
  120. eg. To get my GIF from the supplied sample setup, you would have a URL:
  121. gopher://host.domain/gg/stewart.gif
  122. The client sends to the server:   g/stewart.gif
  123. and the server sends <gopher$base>.g.stewart/gif
  124.  
  125. The web client would ASSUME that the object was a GIF based on the
  126. first g in the URL, although it may check the returned object to
  127. confirm that.
  128.  
  129. ==END==
  130.